SM.h

Go to the documentation of this file.

#ifndef SM_H_
#define SM_H_

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

/* Error masks */
#define SM_STATE_IS_EXECUTING    BIT30
#define SM_INVALID_SOURCE_STATE  BIT31

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

#define LOCK_STATE_EXECUTION()   gu32SMStateStatus |= SM_STATE_IS_EXECUTING
#define UNLOCK_STATE_EXECUTION() gu32SMStateStatus &= ~SM_STATE_IS_EXECUTING


/*** Enums ***/
enum SM_STATE_VARIABLE_INDEX
{
  SM_PREVIOUS_STATE = 0u, SM_NEXT_STATE
};

enum SM_STATE_INDEX
{
  SM_STATE_APP_INIT = 0u, SM_STATE_ERROR, SM_STATE_ACQUISITION, 
  SM_STATE_DECISION, SM_STATE_DEPLOYMENT, SM_STATE_SYSTEM_TEST, 
  SM_STATE_GUI
};

/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Global ***/
extern uint16_t gu16SMCurrentState[2u];
extern uint32_t gu32SMStateStatus;
/*** Static ***/

/*** Constant ***/
extern uint32_t (* const u32pfnState[])(void);
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:         u32fnSMLaunch()
 *
 */
uint32_t u32fnSMLaunch(void);
/*
 ******************************************************************************
 *
 * Function:         vfnSMWriteNextState()
 *
 */
void vfnSMWriteNextState(uint16_t u16NextState);
/*
 ******************************************************************************
 *
 * Function:         u32fnSMValidateCurrentState()
 *
 */
uint32_t u32fnSMValidateCurrentState(uint16_t* pu16ValidStateList,
                                   uint16_t u16Size);
/* **************** Below lie state definitions which may be *****************/
/* **************** implemented elsewhere (a.k.a. other files) ***************/
/*
 ******************************************************************************
 *
 * Function:         u32fnSMInit()
 *
 */
uint32_t u32fnSMAppInit(void);
/*
 ******************************************************************************
 *
 * Function:         u32fnStateAcquisition()
 *
 */
uint32_t u32fnStateAcquisition(void);
/*
 ******************************************************************************
 *
 * Function:         u32fnStateDecision()
 *
 */
uint32_t u32fnStateDecision(void);
/*
 ******************************************************************************
 *
 * Function:         u32fnStateDeployment()
 *
 */
uint32_t u32fnStateDeployment(void);
/*
 ******************************************************************************
 *
 * Function:         u32fnStateSystemTest()
 *
 */
uint32_t u32fnStateSystemTest(void);
/*
 ******************************************************************************
 *
 * Function:         u32fnStateError()
 *
 */
uint32_t u32fnStateError(void);
/*
 ******************************************************************************
 *
 * Function:         u32fnStateGUI()
 *
 */
uint32_t u32fnStateGUI(void);
#endif /* SM_H_ */